feat(http): refactor node:http client instrumentation for portability#20393
Open
feat(http): refactor node:http client instrumentation for portability#20393
Conversation
isaacs
force-pushed
the
isaacschlueter/portable-http-integration-client
branch
from
1f9cef2 to
5ab332a
Compare
Contributor
size-limit report 📦
|
isaacs
force-pushed
the
isaacschlueter/portable-http-integration-client
branch
3 times, most recently
from
18b93f6 to
fd04ed5
Compare
isaacs
added a commit
that referenced
this pull request
Apr 20, 2026
Refactor the `node:http` outgoing request instrumentation so that it can be applied to non-Node.js environments by patching the http module. Also, refactor so that the diagnostics_channel and monkeypatching paths can share code, and so that light and normal node-core instrumentations can share more of the functionality as well. To facilitate this, some portable minimal types are vendored in from the `node:http` module.
isaacs
force-pushed
the
isaacschlueter/portable-http-integration-client
branch
from
0877c6e to
1963717
Compare
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
isaacs
added a commit
that referenced
this pull request
Apr 20, 2026
Refactor the `node:http` outgoing request instrumentation so that it can be applied to non-Node.js environments by patching the http module. Also, refactor so that the diagnostics_channel and monkeypatching paths can share code, and so that light and normal node-core instrumentations can share more of the functionality as well. To facilitate this, some portable minimal types are vendored in from the `node:http` module.
isaacs
force-pushed
the
isaacschlueter/portable-http-integration-client
branch
from
1963717 to
3e7001c
Compare
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
isaacs
added a commit
that referenced
this pull request
Apr 20, 2026
isaacs
added a commit
that referenced
this pull request
Apr 20, 2026
Refactor the `node:http` outgoing request instrumentation so that it can be applied to non-Node.js environments by patching the http module. Also, refactor so that the diagnostics_channel and monkeypatching paths can share code, and so that light and normal node-core instrumentations can share more of the functionality as well. To facilitate this, some portable minimal types are vendored in from the `node:http` module.
isaacs
force-pushed
the
isaacschlueter/portable-http-integration-client
branch
from
0307e3a to
640f8f0
Compare
isaacs
added a commit
that referenced
this pull request
Apr 20, 2026
isaacs
added a commit
that referenced
this pull request
Apr 20, 2026
isaacs
added a commit
that referenced
this pull request
Apr 20, 2026
isaacs
added a commit
that referenced
this pull request
Apr 20, 2026
isaacs
added a commit
that referenced
this pull request
Apr 20, 2026
Refactor the `node:http` outgoing request instrumentation so that it can be applied to non-Node.js environments by patching the http module. Also, refactor so that the diagnostics_channel and monkeypatching paths can share code, and so that light and normal node-core instrumentations can share more of the functionality as well. To facilitate this, some portable minimal types are vendored in from the `node:http` module.
isaacs
force-pushed
the
isaacschlueter/portable-http-integration-client
branch
from
1b8377c to
1a8d51e
Compare
isaacs
added a commit
that referenced
this pull request
Apr 20, 2026
isaacs
added a commit
that referenced
this pull request
Apr 28, 2026
Refactor the `node:http` outgoing request instrumentation so that it can be applied to non-Node.js environments by patching the http module. Also, refactor so that the diagnostics_channel and monkeypatching paths can share code, and so that light and normal node-core instrumentations can share more of the functionality as well. To facilitate this, some portable minimal types are vendored in from the `node:http` module.
isaacs
force-pushed
the
isaacschlueter/portable-http-integration-client
branch
from
645dc0e to
e88e5f5
Compare
isaacs
added a commit
that referenced
this pull request
Apr 28, 2026
Refactor the `node:http` outgoing request instrumentation so that it can be applied to non-Node.js environments by patching the http module. Also, refactor so that the diagnostics_channel and monkeypatching paths can share code, and so that light and normal node-core instrumentations can share more of the functionality as well. To facilitate this, some portable minimal types are vendored in from the `node:http` module.
isaacs
force-pushed
the
isaacschlueter/portable-http-integration-client
branch
from
e88e5f5 to
ddd2987
Compare
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
There are 2 total unresolved issues (including 1 from previous review).
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit ddd2987. Configure here.
isaacs
added a commit
that referenced
this pull request
Apr 28, 2026
isaacs
added a commit
that referenced
this pull request
Apr 28, 2026
isaacs
added a commit
that referenced
this pull request
Apr 28, 2026
isaacs
added a commit
that referenced
this pull request
Apr 28, 2026
Refactor the `node:http` outgoing request instrumentation so that it can be applied to non-Node.js environments by patching the http module. Also, refactor so that the diagnostics_channel and monkeypatching paths can share code, and so that light and normal node-core instrumentations can share more of the functionality as well. To facilitate this, some portable minimal types are vendored in from the `node:http` module.
isaacs
added a commit
that referenced
this pull request
Apr 28, 2026
isaacs
force-pushed
the
isaacschlueter/portable-http-integration-client
branch
from
24f03e6 to
eac6329
Compare
isaacs
added a commit
that referenced
this pull request
Apr 28, 2026
isaacs
added a commit
that referenced
this pull request
Apr 28, 2026
Refactor the `node:http` outgoing request instrumentation so that it can be applied to non-Node.js environments by patching the http module. Also, refactor so that the diagnostics_channel and monkeypatching paths can share code, and so that light and normal node-core instrumentations can share more of the functionality as well. To facilitate this, some portable minimal types are vendored in from the `node:http` module.
isaacs
force-pushed
the
isaacschlueter/portable-http-integration-client
branch
from
aacfec1 to
edb38de
Compare
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
isaacs
added a commit
that referenced
this pull request
Apr 28, 2026
Refactor the `node:http` outgoing request instrumentation so that it can be applied to non-Node.js environments by patching the http module. Also, refactor so that the diagnostics_channel and monkeypatching paths can share code, and so that light and normal node-core instrumentations can share more of the functionality as well. To facilitate this, some portable minimal types are vendored in from the `node:http` module.
isaacs
force-pushed
the
isaacschlueter/portable-http-integration-client
branch
from
edb38de to
0c11611
Compare
isaacs
added a commit
that referenced
this pull request
Apr 28, 2026
Refactor the `node:http` outgoing request instrumentation so that it can be applied to non-Node.js environments by patching the http module. Also, refactor so that the diagnostics_channel and monkeypatching paths can share code, and so that light and normal node-core instrumentations can share more of the functionality as well. To facilitate this, some portable minimal types are vendored in from the `node:http` module.
isaacs
force-pushed
the
isaacschlueter/portable-http-integration-client
branch
from
0c11611 to
76df64d
Compare
JPeer264
approved these changes
Apr 29, 2026
| @@ -0,0 +1,86 @@ | |||
| import { createTestServer } from '@sentry-internal/test-utils'; | |||
Member
There was a problem hiding this comment.
Extremely nice that there are tests for this scenario. Maybe it makes sense to display a warning in our docs too: https://docs.sentry.io/platforms/javascript/guides/node/configuration/integrations/http/ (not sure if this is the best place to put it)
| const baggageEntry = `${encodeURIComponent(objectKey)}=${encodeURIComponent(objectValue)}`; | ||
| const newBaggageHeader = currentIndex === 0 ? baggageEntry : `${baggageHeader},${baggageEntry}`; | ||
| if (newBaggageHeader.length > MAX_BAGGAGE_STRING_LENGTH) { | ||
| /* v8 ignore start */ |
Member
There was a problem hiding this comment.
q: Why exactly is this needed?
Member
Author
There was a problem hiding this comment.
There's a test verifying that it hit the limit, but I didn't feel like it was essential to mock out the debugging and verify the log, so the ignore just marks it as "not tested, but it's fine". This gets the function to full coverage, while marking that we're cheating a bit to do so. Arguably this is a bit lazy, but the v8 ignore comment sort of acts as a TODO.
This was implemented for the portable Express integration, but others will need the same functionality, so make it a reusable util.
Refactor the `node:http` outgoing request instrumentation so that it can be applied to non-Node.js environments by patching the http module. Also, refactor so that the diagnostics_channel and monkeypatching paths can share code, and so that light and normal node-core instrumentations can share more of the functionality as well. To facilitate this, some portable minimal types are vendored in from the `node:http` module.
andreiborza
reviewed
Apr 30, 2026
Comment on lines
+38
to
+69
| if (sentryTrace && !request.getHeader('sentry-trace')) { | ||
| try { | ||
| request.setHeader('sentry-trace', sentryTrace); | ||
| DEBUG_BUILD && debug.log(LOG_PREFIX, 'Added sentry-trace header'); | ||
| } catch (e) { | ||
| DEBUG_BUILD && | ||
| debug.error(LOG_PREFIX, 'Failed to set sentry-trace header:', isError(e) ? e.message : 'Unknown error'); | ||
| } | ||
| } | ||
|
|
||
| if (traceparent && !request.getHeader('traceparent')) { | ||
| try { | ||
| request.setHeader('traceparent', traceparent); | ||
| DEBUG_BUILD && debug.log(LOG_PREFIX, 'Added traceparent header'); | ||
| } catch (e) { | ||
| DEBUG_BUILD && | ||
| debug.error(LOG_PREFIX, 'Failed to set traceparent header:', isError(e) ? e.message : 'Unknown error'); | ||
| } | ||
| } | ||
|
|
||
| if (baggage) { | ||
| const merged = mergeBaggageHeaders(request.getHeader('baggage'), baggage); | ||
| if (merged) { | ||
| try { | ||
| request.setHeader('baggage', merged); | ||
| DEBUG_BUILD && debug.log(LOG_PREFIX, 'Added baggage header'); | ||
| } catch (e) { | ||
| DEBUG_BUILD && | ||
| debug.error(LOG_PREFIX, 'Failed to set baggage header:', isError(e) ? e.message : 'Unknown error'); | ||
| } | ||
| } | ||
| } |
Member
There was a problem hiding this comment.
m: On develop we currently skip setting traceparent and modifying baggage if the request already has a sentry-trace. In this refactoring we only skip overwriting sentry-trace.
See:
sentry-javascript/packages/node-core/src/utils/outgoingHttpRequest.ts
Lines 66 to 117 in d58f82a
And in fetch:
Member
Author
There was a problem hiding this comment.
Hm, yeah, I think one of the clankers complained about this. In this file, I opted to just keep it as it was already in the code that I was porting, but it's probably a good time to update and make it consistent. Easy enough to update, good catch!
Comment on lines
+85
to
+87
| if (getCurrentScope().getScopeData().sdkProcessingMetadata[SUPPRESS_TRACING_KEY] === true) { | ||
| return; | ||
| } |
Member
There was a problem hiding this comment.
l: The behavior here changed slightly, on develop we first check for suppression and only then check the ignoreOutgoingRequests hook. So users could now potentially observe these despite being marked for suppressed.
Nothing critical here, just a small deviation.
Member
Author
There was a problem hiding this comment.
Hm, that's a good point, it is also slightly less efficient to run a userland function than to just check a flag.
| ? '' | ||
| : `:${requestOptions.port}`; | ||
| const path = requestOptions.path ? requestOptions.path : '/'; | ||
| return `${protocol}//${hostname}${port}${path}`; |
Member
There was a problem hiding this comment.
m: Since breadcrumbs now also use this helper, I found out that there's a slight deviation from develop specifically for breadcrumbs when requestOptions.path is already an absolute path. We'd end up with something like http://proxy.localhttp://example.com/foo if the request looked like this:
const req = http.request({
host: 'proxy.local',
port: 3128,
method: 'GET',
path: 'http://target.example/foo',
});Whereas on develop, we would get just http://target.example/foo.
Now, the interesting part is that spans, ignore callbacks, trace propagation etc were all going through this same logic on develop already, so if this is an issue, it was already an issue before.
Breadcrumbs seems to be the only path that did this correctly, maybe we can align on that instead?
| } | ||
| const { outgoingRequestApplyCustomAttributes: applyCustomAttributesOnSpan, ...options } = this.getConfig(); | ||
| const patchOptions: HttpInstrumentationOptions = { | ||
| propagateTrace: options.propagateTraceInOutgoingRequests, |
Member
There was a problem hiding this comment.
q/l: Do options contain propagateTrace? Wonder if the spreading further down might overwrite it. If not, disregard.
| expect(request.setHeader).not.toHaveBeenCalledWith('traceparent', expect.anything()); | ||
| }); | ||
|
|
||
| it('merges baggage with existing baggage header', () => { |
Member
There was a problem hiding this comment.
m: I think we need another test here to check this does not happen when sentry-trace is already present (regression from what's on develop, see other comment).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Refactor the
node:httpoutgoing request instrumentation so that it canbe applied to non-Node.js environments by patching the http module.
Also, refactor so that the diagnostics_channel and monkeypatching paths
can share code, and so that light and normal node-core instrumentations
can share more of the functionality as well.
To facilitate this, some portable minimal types are vendored in from the
node:httpmodule.yarn lint) & (yarn test).Notes on test changes:
conditionalTeston a node version.originspan data changes from the vague (and now incorrect)auto.http.otel.httptoauto.http.clientfor client spans. This also affects a lot of the tests.Otherwise, all prior behavior should be unchanged, which is reflected in the integration and unit tests.